<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityProviderMethodStoreImpl xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/core/EntityProviderMethodStoreImpl.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityProviderMethodStoreImpl.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/core/EntityProviderMethodStoreImpl.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityProviderMethodStore.java - entity-broker - Jan 13, 2009 11:02:43 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski @ gmail.com) (aaronz @ vt.edu) (aaron @ caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.entitybus.util.core;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.OutputStream;
<a name="18" href="#18">18</a>  <strong>import</strong> java.lang.reflect.Method;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.ArrayList;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.HashMap;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.HashSet;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.List;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Map;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Map.Entry;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityReference;
<a name="33" href="#33">33</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="34" href="#34">34</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProvider;
<a name="35" href="#35">35</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderMethodStore;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.annotations.EntityCustomAction;
<a name="37" href="#37">37</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.annotations.EntityURLRedirect;
<a name="38" href="#38">38</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.ActionsDefineable;
<a name="39" href="#39">39</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.ActionsExecutable;
<a name="40" href="#40">40</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RedirectControllable;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RedirectDefinable;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.CustomAction;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.TemplateMap;
<a name="44" href="#44">44</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.URLRedirect;
<a name="45" href="#45">45</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.search.Search;
<a name="46" href="#46">46</a>  
<a name="47" href="#47">47</a>  <strong>import</strong> org.sakaiproject.entitybus.util.TemplateParseUtil;
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>  <em>/**<em>*</em></em>
<a name="51" href="#51">51</a>  <em> * This stores the various methods used to track different methods allowed for providers</em>
<a name="52" href="#52">52</a>  <em> * and also tracks the various methods in the registry</em>
<a name="53" href="#53">53</a>  <em> * </em>
<a name="54" href="#54">54</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="55" href="#55">55</a>  <em> */</em>
<a name="56" href="#56">56</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/core/EntityProviderMethodStoreImpl.html">EntityProviderMethodStoreImpl</a> implements EntityProviderMethodStore {
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(EntityProviderMethodStoreImpl.<strong>class</strong>);
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <strong>private</strong> HashSet&lt;String> reservedActions = <strong>null</strong>;
<a name="61" href="#61">61</a>      <strong>private</strong> Map&lt;String, Map&lt;String, CustomAction>> entityActions = <strong>new</strong> ConcurrentHashMap&lt;String, Map&lt;String,CustomAction>>();
<a name="62" href="#62">62</a>      <strong>private</strong> Map&lt;String, List&lt;URLRedirect>> entityRedirects = <strong>new</strong> ConcurrentHashMap&lt;String, List&lt;URLRedirect>>();
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>      <em>/**<em>*</em></em>
<a name="65" href="#65">65</a>  <em>     * Full constructor</em>
<a name="66" href="#66">66</a>  <em>     */</em>
<a name="67" href="#67">67</a>      <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/util/core/EntityProviderMethodStoreImpl.html">EntityProviderMethodStoreImpl</a>() {
<a name="68" href="#68">68</a>          reservedActions = <strong>new</strong> HashSet&lt;String>(4);
<a name="69" href="#69">69</a>          reservedActions.add(<span class="string">"describe"</span>);
<a name="70" href="#70">70</a>          reservedActions.add(<span class="string">"new"</span>);
<a name="71" href="#71">71</a>          reservedActions.add(<span class="string">"edit"</span>);
<a name="72" href="#72">72</a>          reservedActions.add(<span class="string">"delete"</span>);
<a name="73" href="#73">73</a>      }
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em class="comment">// ACTIONS</em>
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="78" href="#78">78</a>  <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#findCustomActions(org.sakaiproject.entitybus.entityprovider.EntityProvider, boolean)</em>
<a name="79" href="#79">79</a>  <em class="comment">     */</em>
<a name="80" href="#80">80</a>      <strong>public</strong> CustomAction[] findCustomActions(EntityProvider entityProvider, <strong>boolean</strong> ignoreFailures) {
<a name="81" href="#81">81</a>          ArrayList&lt;CustomAction> actions = <strong>new</strong> ArrayList&lt;CustomAction>();
<a name="82" href="#82">82</a>          Method[] methods = entityProvider.getClass().getMethods();
<a name="83" href="#83">83</a>          <strong>for</strong> (Method method : methods) {
<a name="84" href="#84">84</a>              <strong>if</strong> (method.isAnnotationPresent(EntityCustomAction.<strong>class</strong>)) {
<a name="85" href="#85">85</a>                  EntityCustomAction ecaAnnote = method.getAnnotation(EntityCustomAction.<strong>class</strong>);
<a name="86" href="#86">86</a>                  String action = ecaAnnote.action();
<a name="87" href="#87">87</a>                  <strong>if</strong> (<strong>null</strong> == action || <span class="string">""</span>.equals(action)) {
<a name="88" href="#88">88</a>                      action = method.getName();
<a name="89" href="#89">89</a>                  }
<a name="90" href="#90">90</a>                  String viewKey = ecaAnnote.viewKey();
<a name="91" href="#91">91</a>                  <strong>if</strong> (<strong>null</strong> == viewKey || <span class="string">""</span>.equals(viewKey)) {
<a name="92" href="#92">92</a>                      <em class="comment">//viewKey = EntityView.VIEW_SHOW;</em>
<a name="93" href="#93">93</a>                      viewKey = <strong>null</strong>; <em class="comment">// allow any type of request</em>
<a name="94" href="#94">94</a>                  }
<a name="95" href="#95">95</a>                  CustomAction ca = <strong>new</strong> CustomAction(action, viewKey, method.getName());
<a name="96" href="#96">96</a>                  <strong>try</strong> {
<a name="97" href="#97">97</a>                      ca.methodArgTypes = validateActionParamTypes(method.getParameterTypes(), method.getName());
<a name="98" href="#98">98</a>                  } <strong>catch</strong>(IllegalArgumentException e) {
<a name="99" href="#99">99</a>                      <strong>if</strong> (! ignoreFailures) {
<a name="100" href="#100">100</a>                         <strong>throw</strong> <strong>new</strong> IllegalArgumentException(e);
<a name="101" href="#101">101</a>                     }
<a name="102" href="#102">102</a>                 }
<a name="103" href="#103">103</a>                 ca.setMethod(method); <em class="comment">// store the method in the ca</em>
<a name="104" href="#104">104</a>                 actions.add(ca);
<a name="105" href="#105">105</a>             } <strong>else</strong> <strong>if</strong> (method.getName().endsWith(ActionsExecutable.ACTION_METHOD_SUFFIX)) {
<a name="106" href="#106">106</a>                 String action = method.getName().substring(0, method.getName().length() - ActionsExecutable.ACTION_METHOD_SUFFIX.length());
<a name="107" href="#107">107</a>                 CustomAction ca = <strong>new</strong> CustomAction(action, EntityView.VIEW_SHOW, method.getName());
<a name="108" href="#108">108</a>                 <strong>try</strong> {
<a name="109" href="#109">109</a>                     ca.methodArgTypes = validateActionParamTypes(method.getParameterTypes(), method.getName());
<a name="110" href="#110">110</a>                 } <strong>catch</strong> (IllegalArgumentException e) {
<a name="111" href="#111">111</a>                     log.warn(<span class="string">"A method ("</span>+method.getName()+<span class="string">") in the entity provider for prefix ("</span>
<a name="112" href="#112">112</a>                             + entityProvider.getEntityPrefix()+<span class="string">") appears to be a custom action method but"</span>
<a name="113" href="#113">113</a>                             + <span class="string">"does not have a valid set of parameter types, this may be ok but should be checked on: "</span> + e.getMessage());
<a name="114" href="#114">114</a>                     <strong>continue</strong>;
<a name="115" href="#115">115</a>                 }
<a name="116" href="#116">116</a>                 ca.setMethod(method); <em class="comment">// store the method in the ca</em>
<a name="117" href="#117">117</a>                 actions.add(ca);
<a name="118" href="#118">118</a>             }
<a name="119" href="#119">119</a>         }
<a name="120" href="#120">120</a>         <strong>return</strong> actions.toArray(<strong>new</strong> CustomAction[actions.size()]);
<a name="121" href="#121">121</a>     }
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>     <em>/**<em>*</em></em>
<a name="124" href="#124">124</a> <em>     * Set the custom actions for this prefix</em>
<a name="125" href="#125">125</a> <em>     * @param prefix an entity prefix</em>
<a name="126" href="#126">126</a> <em>     * @param actions a map of action -> {@link CustomAction}</em>
<a name="127" href="#127">127</a> <em>     */</em>
<a name="128" href="#128">128</a>     <strong>public</strong> <strong>void</strong> setCustomActions(String prefix, Map&lt;String,CustomAction> actions) {
<a name="129" href="#129">129</a>         Map&lt;String,CustomAction> cas = <strong>new</strong> HashMap&lt;String, CustomAction>();
<a name="130" href="#130">130</a>         StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="131" href="#131">131</a>         <strong>for</strong> (Entry&lt;String, CustomAction> ca : actions.entrySet()) {
<a name="132" href="#132">132</a>             CustomAction action = ca.getValue();
<a name="133" href="#133">133</a>             <strong>if</strong> (action == <strong>null</strong> || ca.getKey() == <strong>null</strong> || <span class="string">""</span>.equals(ca.getKey())) {
<a name="134" href="#134">134</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"custom action object and action key must not be null"</span>);
<a name="135" href="#135">135</a>             }
<a name="136" href="#136">136</a>             <strong>if</strong> (reservedActions.contains(ca.getKey().toLowerCase())) {
<a name="137" href="#137">137</a>                 StringBuilder rsb = <strong>new</strong> StringBuilder();
<a name="138" href="#138">138</a>                 <strong>for</strong> (String reserved : reservedActions) {
<a name="139" href="#139">139</a>                     <strong>if</strong> (rsb.length() > 0) {
<a name="140" href="#140">140</a>                         rsb.append(<span class="string">", "</span>);
<a name="141" href="#141">141</a>                     }
<a name="142" href="#142">142</a>                     rsb.append(reserved);
<a name="143" href="#143">143</a>                 }
<a name="144" href="#144">144</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(ca.getKey() + <span class="string">" is a reserved word and cannot be used as a custom action key "</span>
<a name="145" href="#145">145</a>                         + <span class="string">", reserved words include: "</span> + rsb);
<a name="146" href="#146">146</a>             }
<a name="147" href="#147">147</a>             <strong>if</strong> (sb.length() > 0) {
<a name="148" href="#148">148</a>                 sb.append(<span class="string">", "</span>);
<a name="149" href="#149">149</a>             }
<a name="150" href="#150">150</a>             sb.append(ca.getValue().toString());
<a name="151" href="#151">151</a>             cas.put(ca.getKey(), action.copy()); <em class="comment">// make a copy to avoid holding objects from another ClassLoader</em>
<a name="152" href="#152">152</a>         }
<a name="153" href="#153">153</a>         entityActions.put(prefix, actions);
<a name="154" href="#154">154</a>         log.info(<span class="string">"Registered "</span>+actions.size()+<span class="string">" custom actions for entity prefix ("</span>+prefix+<span class="string">"): "</span> + sb.toString());
<a name="155" href="#155">155</a>     }
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="158" href="#158">158</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#addCustomAction(java.lang.String, org.sakaiproject.entitybus.entityprovider.extension.CustomAction)</em>
<a name="159" href="#159">159</a> <em class="comment">     */</em>
<a name="160" href="#160">160</a>     <strong>public</strong> <strong>void</strong> addCustomAction(String prefix, CustomAction customAction) {
<a name="161" href="#161">161</a>         <em class="comment">// NOTE: we are always creating a new map here to ensure there are no collisions</em>
<a name="162" href="#162">162</a>         Map&lt;String,CustomAction> actions = <strong>new</strong> HashMap&lt;String, CustomAction>();
<a name="163" href="#163">163</a>         <strong>if</strong> (entityActions.containsKey(prefix)) {
<a name="164" href="#164">164</a>             <em class="comment">// add the existing ones first</em>
<a name="165" href="#165">165</a>             actions.putAll(entityActions.get(prefix));
<a name="166" href="#166">166</a>         }
<a name="167" href="#167">167</a>         <em class="comment">// add the new one to the map</em>
<a name="168" href="#168">168</a>         actions.put(customAction.action, customAction);
<a name="169" href="#169">169</a>         <em class="comment">// put the new map into the store</em>
<a name="170" href="#170">170</a>         setCustomActions(prefix, actions);
<a name="171" href="#171">171</a>     }
<a name="172" href="#172">172</a> 
<a name="173" href="#173">173</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="174" href="#174">174</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#getCustomAction(java.lang.String, java.lang.String)</em>
<a name="175" href="#175">175</a> <em class="comment">     */</em>
<a name="176" href="#176">176</a>     <strong>public</strong> CustomAction getCustomAction(String prefix, String action) {
<a name="177" href="#177">177</a>         CustomAction ca = <strong>null</strong>;
<a name="178" href="#178">178</a>         <strong>if</strong> (entityActions.containsKey(prefix)) {
<a name="179" href="#179">179</a>             ca = entityActions.get(prefix).get(action);
<a name="180" href="#180">180</a>         }
<a name="181" href="#181">181</a>         <strong>return</strong> ca;
<a name="182" href="#182">182</a>     }
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="185" href="#185">185</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#removeCustomActions(java.lang.String)</em>
<a name="186" href="#186">186</a> <em class="comment">     */</em>
<a name="187" href="#187">187</a>     <strong>public</strong> <strong>void</strong> removeCustomActions(String prefix) {
<a name="188" href="#188">188</a>         entityActions.remove(prefix);
<a name="189" href="#189">189</a>     }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="192" href="#192">192</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#getCustomActions(java.lang.String)</em>
<a name="193" href="#193">193</a> <em class="comment">     */</em>
<a name="194" href="#194">194</a>     <strong>public</strong> List&lt;CustomAction> getCustomActions(String prefix) {
<a name="195" href="#195">195</a>         List&lt;CustomAction> actions = <strong>new</strong> ArrayList&lt;CustomAction>();
<a name="196" href="#196">196</a>         Map&lt;String, CustomAction> actionMap = entityActions.get(prefix);
<a name="197" href="#197">197</a>         <strong>if</strong> (actionMap != <strong>null</strong>) {
<a name="198" href="#198">198</a>             <strong>for</strong> (Entry&lt;String, CustomAction> entry : actionMap.entrySet()) {
<a name="199" href="#199">199</a>                 actions.add(entry.getValue());
<a name="200" href="#200">200</a>             }
<a name="201" href="#201">201</a>         }
<a name="202" href="#202">202</a>         <strong>return</strong> actions;
<a name="203" href="#203">203</a>     }
<a name="204" href="#204">204</a> 
<a name="205" href="#205">205</a> 
<a name="206" href="#206">206</a>     <em class="comment">// REDIRECTS</em>
<a name="207" href="#207">207</a> 
<a name="208" href="#208">208</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="209" href="#209">209</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#findURLRedirectMethods(org.sakaiproject.entitybus.entityprovider.EntityProvider)</em>
<a name="210" href="#210">210</a> <em class="comment">     */</em>
<a name="211" href="#211">211</a>     <strong>public</strong> URLRedirect[] findURLRedirectMethods(EntityProvider entityProvider) {
<a name="212" href="#212">212</a>         ArrayList&lt;URLRedirect> redirects = <strong>new</strong> ArrayList&lt;URLRedirect>();
<a name="213" href="#213">213</a>         Method[] methods = entityProvider.getClass().getMethods();
<a name="214" href="#214">214</a>         <strong>for</strong> (Method method : methods) {
<a name="215" href="#215">215</a>             <strong>if</strong> (method.isAnnotationPresent(EntityURLRedirect.<strong>class</strong>)) {
<a name="216" href="#216">216</a>                 EntityURLRedirect eurAnnote = method.getAnnotation(EntityURLRedirect.<strong>class</strong>);
<a name="217" href="#217">217</a>                 String template = eurAnnote.value();
<a name="218" href="#218">218</a>                 <strong>if</strong> (<strong>null</strong> == template || <span class="string">""</span>.equals(template)) {
<a name="219" href="#219">219</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"there is no template set for the annotation: "</span> + EntityURLRedirect.<strong>class</strong>);
<a name="220" href="#220">220</a>                 }
<a name="221" href="#221">221</a>                 URLRedirect redirect = <strong>null</strong>;
<a name="222" href="#222">222</a>                 <strong>try</strong> {
<a name="223" href="#223">223</a>                     redirect = <strong>new</strong> URLRedirect(template, method.getName(), 
<a name="224" href="#224">224</a>                             validateRedirectParamTypes(method.getParameterTypes(), method.getName()));
<a name="225" href="#225">225</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="226" href="#226">226</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failed to validate redirect templates from methods for prefix ("</span>
<a name="227" href="#227">227</a>                             +entityProvider.getEntityPrefix() + <span class="string">"): "</span> + e.getMessage(), e);
<a name="228" href="#228">228</a>                 }
<a name="229" href="#229">229</a>                 redirect.setMethod(method); <em class="comment">// cache to reduce lookup cost</em>
<a name="230" href="#230">230</a>                 redirects.add(redirect);
<a name="231" href="#231">231</a>             }
<a name="232" href="#232">232</a>         }
<a name="233" href="#233">233</a>         <strong>return</strong> redirects.toArray(<strong>new</strong> URLRedirect[redirects.size()]);
<a name="234" href="#234">234</a>     }
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="237" href="#237">237</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#addURLRedirects(java.lang.String, org.sakaiproject.entitybus.util.request.URLRedirect[])</em>
<a name="238" href="#238">238</a> <em class="comment">     */</em>
<a name="239" href="#239">239</a>     <strong>public</strong> <strong>void</strong> addURLRedirects(String prefix, URLRedirect[] redirects) {
<a name="240" href="#240">240</a>         <strong>if</strong> (redirects != <strong>null</strong> &amp;&amp; redirects.length > 0) {
<a name="241" href="#241">241</a>             ArrayList&lt;URLRedirect> urlRedirects = <strong>new</strong> ArrayList&lt;URLRedirect>();
<a name="242" href="#242">242</a>             <strong>if</strong> (entityRedirects.containsKey(prefix)) {
<a name="243" href="#243">243</a>                 List&lt;URLRedirect> current = entityRedirects.get(prefix);
<a name="244" href="#244">244</a>                 urlRedirects.addAll(current);
<a name="245" href="#245">245</a>             }
<a name="246" href="#246">246</a>             StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="247" href="#247">247</a>             <strong>for</strong> (URLRedirect redirect : redirects) {
<a name="248" href="#248">248</a>                 <strong>if</strong> (redirect == <strong>null</strong> || redirect.template == <strong>null</strong> || <span class="string">""</span>.equals(redirect.template)) {
<a name="249" href="#249">249</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"url redirect and pattern template must not be null"</span>);
<a name="250" href="#250">250</a>                 }
<a name="251" href="#251">251</a>                 <strong>if</strong> (redirect.outgoingTemplate == <strong>null</strong> 
<a name="252" href="#252">252</a>                         &amp;&amp; redirect.methodName == <strong>null</strong>
<a name="253" href="#253">253</a>                         &amp;&amp; redirect.controllable == false) {
<a name="254" href="#254">254</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"url redirect targetTemplate or methodName must not be null"</span>);            
<a name="255" href="#255">255</a>                 }
<a name="256" href="#256">256</a>                 <strong>if</strong> (sb.length() > 0) {
<a name="257" href="#257">257</a>                     sb.append(<span class="string">", "</span>);
<a name="258" href="#258">258</a>                 }
<a name="259" href="#259">259</a>                 <strong>if</strong> (urlRedirects.contains(redirect)) {
<a name="260" href="#260">260</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Duplicate redirect template definition: "</span> +
<a name="261" href="#261">261</a>                             <span class="string">"The redirect set already contains this template: "</span> + redirect.template + <span class="string">", it cannot contain 2 identical templates"</span>);
<a name="262" href="#262">262</a>                 }
<a name="263" href="#263">263</a>                 urlRedirects.add(redirect);
<a name="264" href="#264">264</a>                 sb.append(redirect.template);
<a name="265" href="#265">265</a>             }
<a name="266" href="#266">266</a>             entityRedirects.put(prefix, urlRedirects);
<a name="267" href="#267">267</a>             log.info(<span class="string">"Registered "</span>+redirects.length+<span class="string">" url redirects for entity prefix ("</span>+prefix+<span class="string">"): "</span> + sb.toString());
<a name="268" href="#268">268</a>         }
<a name="269" href="#269">269</a>     }
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="272" href="#272">272</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#removeURLRedirects(java.lang.String)</em>
<a name="273" href="#273">273</a> <em class="comment">     */</em>
<a name="274" href="#274">274</a>     <strong>public</strong> <strong>void</strong> removeURLRedirects(String prefix) {
<a name="275" href="#275">275</a>         entityRedirects.remove(prefix);
<a name="276" href="#276">276</a>     }
<a name="277" href="#277">277</a> 
<a name="278" href="#278">278</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="279" href="#279">279</a> <em class="comment">     * @see org.sakaiproject.entitybus.impl.EntityProviderMethodStoreAPI#getURLRedirects(java.lang.String)</em>
<a name="280" href="#280">280</a> <em class="comment">     */</em>
<a name="281" href="#281">281</a>     <strong>public</strong> List&lt;URLRedirect> getURLRedirects(String prefix) {
<a name="282" href="#282">282</a>         List&lt;URLRedirect> redirects = <strong>new</strong> ArrayList&lt;URLRedirect>();
<a name="283" href="#283">283</a>         <strong>if</strong> (entityRedirects.containsKey(prefix)) {
<a name="284" href="#284">284</a>             redirects.addAll( entityRedirects.get(prefix) );
<a name="285" href="#285">285</a>         }
<a name="286" href="#286">286</a>         <strong>return</strong> redirects;
<a name="287" href="#287">287</a>     }
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a> 
<a name="290" href="#290">290</a>     <em class="comment">// STATICS</em>
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>     <strong>protected</strong> <strong>static</strong> Class&lt;?>[] validActionParamTypes = {
<a name="293" href="#293">293</a>         EntityReference.<strong>class</strong>,
<a name="294" href="#294">294</a>         EntityView.<strong>class</strong>,
<a name="295" href="#295">295</a>         Search.<strong>class</strong>,
<a name="296" href="#296">296</a>         String.<strong>class</strong>,
<a name="297" href="#297">297</a>         OutputStream.<strong>class</strong>,
<a name="298" href="#298">298</a>         Map.<strong>class</strong>
<a name="299" href="#299">299</a>     };
<a name="300" href="#300">300</a>     <strong>protected</strong> <strong>static</strong> Class&lt;?>[] validRedirectParamTypes = {
<a name="301" href="#301">301</a>         String.<strong>class</strong>,
<a name="302" href="#302">302</a>         String[].<strong>class</strong>,
<a name="303" href="#303">303</a>         Map.<strong>class</strong>
<a name="304" href="#304">304</a>     };
<a name="305" href="#305">305</a>     <em>/**<em>*</em></em>
<a name="306" href="#306">306</a> <em>     * Validates the parameter types on a method to make sure they are valid</em>
<a name="307" href="#307">307</a> <em>     * @param paramTypes an array of parameter types</em>
<a name="308" href="#308">308</a> <em>     * @param methodName the name of the method which is being validated (for debugging mostly)</em>
<a name="309" href="#309">309</a> <em>     * @return the new valid array of param types</em>
<a name="310" href="#310">310</a> <em>     * @throws IllegalArgumentException if the param types are invalid</em>
<a name="311" href="#311">311</a> <em>     */</em>
<a name="312" href="#312">312</a>     <strong>protected</strong> <strong>static</strong> Class&lt;?>[] validateActionParamTypes(Class&lt;?>[] paramTypes, String methodName) {
<a name="313" href="#313">313</a>         <strong>try</strong> {
<a name="314" href="#314">314</a>             <strong>return</strong> validateParamTypes(paramTypes, validActionParamTypes);
<a name="315" href="#315">315</a>         } <strong>catch</strong> (IllegalArgumentException e) {
<a name="316" href="#316">316</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid custom action method ("</span>+methodName+<span class="string">"): "</span> + e.getMessage(), e);
<a name="317" href="#317">317</a>         }
<a name="318" href="#318">318</a>     }
<a name="319" href="#319">319</a> 
<a name="320" href="#320">320</a>     <em>/**<em>*</em></em>
<a name="321" href="#321">321</a> <em>     * Validates the parameter types on a method to make sure they are valid</em>
<a name="322" href="#322">322</a> <em>     * @param paramTypes an array of parameter types</em>
<a name="323" href="#323">323</a> <em>     * @param methodName the name of the method which is being validated (for debugging mostly)</em>
<a name="324" href="#324">324</a> <em>     * @return the new valid array of param types</em>
<a name="325" href="#325">325</a> <em>     * @throws IllegalArgumentException is the param types are invalid</em>
<a name="326" href="#326">326</a> <em>     */</em>
<a name="327" href="#327">327</a>     <strong>protected</strong> <strong>static</strong> Class&lt;?>[] validateRedirectParamTypes(Class&lt;?>[] paramTypes, String methodName) {
<a name="328" href="#328">328</a>         <strong>try</strong> {
<a name="329" href="#329">329</a>             <strong>return</strong> validateParamTypes(paramTypes, validRedirectParamTypes);
<a name="330" href="#330">330</a>         } <strong>catch</strong> (IllegalArgumentException e) {
<a name="331" href="#331">331</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid redirect method ("</span>+methodName+<span class="string">"): "</span> + e.getMessage(), e);
<a name="332" href="#332">332</a>         }
<a name="333" href="#333">333</a>     }
<a name="334" href="#334">334</a> 
<a name="335" href="#335">335</a>     <em>/**<em>*</em></em>
<a name="336" href="#336">336</a> <em>     * Validates param types against a given list of valid types</em>
<a name="337" href="#337">337</a> <em>     * @param paramTypes an array of parameter types</em>
<a name="338" href="#338">338</a> <em>     * @param validTypes the types that are valid</em>
<a name="339" href="#339">339</a> <em>     * @return the new valid array of param types</em>
<a name="340" href="#340">340</a> <em>     * @throws IllegalArgumentException is the param types are invalid</em>
<a name="341" href="#341">341</a> <em>     */</em>
<a name="342" href="#342">342</a>     <strong>protected</strong> <strong>static</strong> Class&lt;?>[] validateParamTypes(Class&lt;?>[] paramTypes, Class&lt;?>[] validTypes) {
<a name="343" href="#343">343</a>         Class&lt;?>[] validParams = <strong>new</strong> Class&lt;?>[paramTypes.length];
<a name="344" href="#344">344</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; paramTypes.length; i++) {
<a name="345" href="#345">345</a>             <strong>boolean</strong> found = false;
<a name="346" href="#346">346</a>             Class&lt;?> paramType = paramTypes[i];
<a name="347" href="#347">347</a>             <strong>if</strong> (validTypes != <strong>null</strong>) {
<a name="348" href="#348">348</a>                 <strong>for</strong> (<strong>int</strong> j = 0; j &lt; validTypes.length; j++) {
<a name="349" href="#349">349</a>                     <strong>if</strong> (validTypes[j].isAssignableFrom(paramType)) {
<a name="350" href="#350">350</a>                         validParams[i] = validTypes[j];
<a name="351" href="#351">351</a>                         found = <strong>true</strong>;
<a name="352" href="#352">352</a>                     }
<a name="353" href="#353">353</a>                 }
<a name="354" href="#354">354</a>             }
<a name="355" href="#355">355</a>             <strong>if</strong> (!found) {
<a name="356" href="#356">356</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid method params: param type is not allowed: "</span> + paramType.getName() 
<a name="357" href="#357">357</a>                         + <span class="string">" : valid types include: "</span> + ReflectUtils.arrayToString(validTypes));
<a name="358" href="#358">358</a>             }
<a name="359" href="#359">359</a>         }
<a name="360" href="#360">360</a>         <strong>return</strong> validParams;
<a name="361" href="#361">361</a>     }
<a name="362" href="#362">362</a> 
<a name="363" href="#363">363</a>     <em>/**<em>*</em></em>
<a name="364" href="#364">364</a> <em>     * Takes a set of custom actions and validates them</em>
<a name="365" href="#365">365</a> <em>     * @param actionsDefineable an entity provider which uses custom actions</em>
<a name="366" href="#366">366</a> <em>     * @param customActions</em>
<a name="367" href="#367">367</a> <em>     * @throws IllegalArgumentException if the custom actions are invalid</em>
<a name="368" href="#368">368</a> <em>     */</em>
<a name="369" href="#369">369</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> validateCustomActionMethods(ActionsDefineable actionsDefineable) {
<a name="370" href="#370">370</a>         CustomAction[] customActions = actionsDefineable.defineActions();
<a name="371" href="#371">371</a>         Method[] methods = actionsDefineable.getClass().getMethods();
<a name="372" href="#372">372</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; customActions.length; i++) {
<a name="373" href="#373">373</a>             CustomAction ca = customActions[i];
<a name="374" href="#374">374</a>             <strong>if</strong> (ca == <strong>null</strong>) {
<a name="375" href="#375">375</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Custom actions cannot be null"</span>);
<a name="376" href="#376">376</a>             }
<a name="377" href="#377">377</a>             <strong>if</strong> (ca.methodName == <strong>null</strong> || <span class="string">""</span>.equals(ca.methodName)) {
<a name="378" href="#378">378</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Method names must be set for all custom actions when using "</span> + ActionsDefineable.<strong>class</strong>);
<a name="379" href="#379">379</a>             }
<a name="380" href="#380">380</a>             <strong>boolean</strong> found = false;
<a name="381" href="#381">381</a>             <strong>for</strong> (Method method : methods) {
<a name="382" href="#382">382</a>                 String name = method.getName();
<a name="383" href="#383">383</a>                 <strong>if</strong> (name.equals(ca.methodName)) {
<a name="384" href="#384">384</a>                     ca.methodArgTypes = validateActionParamTypes(method.getParameterTypes(), ca.methodName);
<a name="385" href="#385">385</a>                     ca.setMethod(method); <em class="comment">// store the method in the ca</em>
<a name="386" href="#386">386</a>                     found = <strong>true</strong>;
<a name="387" href="#387">387</a>                     <strong>break</strong>;
<a name="388" href="#388">388</a>                 }
<a name="389" href="#389">389</a>             }
<a name="390" href="#390">390</a>             <strong>if</strong> (!found) {
<a name="391" href="#391">391</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"No public method found called ("</span>+ca.methodName
<a name="392" href="#392">392</a>                         +<span class="string">") in the entity provider for prefix ("</span>+actionsDefineable.getEntityPrefix()+<span class="string">"), "</span>
<a name="393" href="#393">393</a>                         + <span class="string">"the method was defined as a custom action by "</span> + ActionsDefineable.<strong>class</strong>);
<a name="394" href="#394">394</a>             }
<a name="395" href="#395">395</a>         }
<a name="396" href="#396">396</a>     }
<a name="397" href="#397">397</a> 
<a name="398" href="#398">398</a>     <em>/**<em>*</em></em>
<a name="399" href="#399">399</a> <em>     * Validates the provided URL templates in an entity provider and outputs the</em>
<a name="400" href="#400">400</a> <em>     * URL redirect objects as an array</em>
<a name="401" href="#401">401</a> <em>     * @param configDefinable the entity provider</em>
<a name="402" href="#402">402</a> <em>     * @return the array of URL redirects</em>
<a name="403" href="#403">403</a> <em>     */</em>
<a name="404" href="#404">404</a>     <strong>public</strong> <strong>static</strong> URLRedirect[] validateDefineableTemplates(RedirectDefinable configDefinable) {
<a name="405" href="#405">405</a>         List&lt;URLRedirect> redirects = <strong>new</strong> ArrayList&lt;URLRedirect>();
<a name="406" href="#406">406</a>         TemplateMap[] urlMappings = configDefinable.defineURLMappings();
<a name="407" href="#407">407</a>         <strong>if</strong> (urlMappings == <strong>null</strong> || urlMappings.length == 0) {
<a name="408" href="#408">408</a>             <em class="comment">// this is ok then, or is it?</em>
<a name="409" href="#409">409</a>             log.warn(<span class="string">"RedirectDefinable: no templates defined for url redirect"</span>);
<a name="410" href="#410">410</a>         } <strong>else</strong> {
<a name="411" href="#411">411</a>             <strong>for</strong> (TemplateMap templateMap : urlMappings) {
<a name="412" href="#412">412</a>                 String incomingTemplate = templateMap.getIncomingTemplate();
<a name="413" href="#413">413</a>                 String outgoingTemplate = templateMap.getOutgoingTemplate();
<a name="414" href="#414">414</a>                 URLRedirect redirect = <strong>null</strong>;
<a name="415" href="#415">415</a>                 <strong>try</strong> {
<a name="416" href="#416">416</a>                     redirect = <strong>new</strong> URLRedirect(incomingTemplate, outgoingTemplate);
<a name="417" href="#417">417</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="418" href="#418">418</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failed to validate defined redirect templates for prefix ("</span>
<a name="419" href="#419">419</a>                             +configDefinable.getEntityPrefix() + <span class="string">"): "</span> + e.getMessage(), e);
<a name="420" href="#420">420</a>                 }
<a name="421" href="#421">421</a>                 <strong>if</strong> (incomingTemplate.equals(outgoingTemplate)) {
<a name="422" href="#422">422</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid outgoing redirect template ("</span>
<a name="423" href="#423">423</a>                             +outgoingTemplate+<span class="string">") for entity prefix ("</span>+configDefinable.getEntityPrefix()
<a name="424" href="#424">424</a>                             +<span class="string">"), template is identical to incoming template ("</span>+incomingTemplate+<span class="string">") and would cause an infinite redirect"</span>);
<a name="425" href="#425">425</a>                 }
<a name="426" href="#426">426</a>                 <em class="comment">// make sure that we check the target vars match the template vars</em>
<a name="427" href="#427">427</a>                 List&lt;String> incomingVars = <strong>new</strong> ArrayList&lt;String>( redirect.preProcessedTemplate.variableNames );
<a name="428" href="#428">428</a>                 incomingVars.add(TemplateParseUtil.PREFIX);
<a name="429" href="#429">429</a>                 incomingVars.add(TemplateParseUtil.EXTENSION);
<a name="430" href="#430">430</a>                 incomingVars.add(TemplateParseUtil.DOT_EXTENSION);
<a name="431" href="#431">431</a>                 incomingVars.add(TemplateParseUtil.QUERY_STRING);
<a name="432" href="#432">432</a>                 incomingVars.add(TemplateParseUtil.QUESTION_QUERY_STRING);
<a name="433" href="#433">433</a>                 List&lt;String> outgoingVars = redirect.outgoingPreProcessedTemplate.variableNames;
<a name="434" href="#434">434</a>                 <strong>if</strong> (incomingVars.containsAll(outgoingVars)) {
<a name="435" href="#435">435</a>                     <em class="comment">// all is ok</em>
<a name="436" href="#436">436</a>                     redirects.add(redirect);
<a name="437" href="#437">437</a>                 } <strong>else</strong> {
<a name="438" href="#438">438</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Outgoing template ("</span>+outgoingTemplate+<span class="string">") has variables which do not occur in "</span>
<a name="439" href="#439">439</a>                             + <span class="string">"incoming template ("</span>+incomingTemplate+<span class="string">") and "</span> + TemplateParseUtil.PREFIX 
<a name="440" href="#440">440</a>                             + <span class="string">", please make sure your outgoing template only includes variables"</span>
<a name="441" href="#441">441</a>                             + <span class="string">" which can be found in the incoming template and "</span> + TemplateParseUtil.PREFIX);
<a name="442" href="#442">442</a>                 }
<a name="443" href="#443">443</a>             }
<a name="444" href="#444">444</a>         }
<a name="445" href="#445">445</a>         <strong>return</strong> redirects.toArray(<strong>new</strong> URLRedirect[redirects.size()]);
<a name="446" href="#446">446</a>     }
<a name="447" href="#447">447</a> 
<a name="448" href="#448">448</a>     <em>/**<em>*</em></em>
<a name="449" href="#449">449</a> <em>     * Execute this validate and get the templates so they can be registered</em>
<a name="450" href="#450">450</a> <em>     * @param configControllable the entity provider</em>
<a name="451" href="#451">451</a> <em>     * @return the array of URL redirects</em>
<a name="452" href="#452">452</a> <em>     */</em>
<a name="453" href="#453">453</a>     <strong>public</strong> <strong>static</strong> URLRedirect[] validateControllableTemplates(RedirectControllable configControllable) {
<a name="454" href="#454">454</a>         List&lt;URLRedirect> redirects = <strong>new</strong> ArrayList&lt;URLRedirect>();
<a name="455" href="#455">455</a>         String[] templates = configControllable.defineHandledTemplatePatterns();
<a name="456" href="#456">456</a>         <strong>if</strong> (templates == <strong>null</strong> || templates.length == 0) {
<a name="457" href="#457">457</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"RedirectControllable: invalid defineHandledTemplatePatterns: "</span> +
<a name="458" href="#458">458</a>             <span class="string">"this should return a non-empty array of templates or the capability should not be used"</span>);
<a name="459" href="#459">459</a>         } <strong>else</strong> {
<a name="460" href="#460">460</a>             <strong>for</strong> (String template : templates) {
<a name="461" href="#461">461</a>                 URLRedirect redirect = <strong>null</strong>;
<a name="462" href="#462">462</a>                 <strong>try</strong> {
<a name="463" href="#463">463</a>                     redirect = <strong>new</strong> URLRedirect(template);
<a name="464" href="#464">464</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="465" href="#465">465</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failed to validate redirect templates from handled template patterns for prefix ("</span>
<a name="466" href="#466">466</a>                             +configControllable.getEntityPrefix() + <span class="string">"): "</span> + e.getMessage(), e);
<a name="467" href="#467">467</a>                 }
<a name="468" href="#468">468</a>                 redirects.add(redirect);
<a name="469" href="#469">469</a>             }
<a name="470" href="#470">470</a>         }
<a name="471" href="#471">471</a>         <strong>return</strong> redirects.toArray(<strong>new</strong> URLRedirect[redirects.size()]);
<a name="472" href="#472">472</a>     }
<a name="473" href="#473">473</a> 
<a name="474" href="#474">474</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

